﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once

#include "GcmpModelInterface.h"
#include "GcmpApiDeclaration.h"

namespace gcmp
{
    class IStandardCodeItem;

    /// \brief 用户使用的特定标准的访问接口。需要由用户实现该接口。
    class GCMP_MODEL_INTERFACE_EXPORT ISpecificStandardCodeSystem
    {
    public:
        virtual ~ISpecificStandardCodeSystem();

    public:
        /// \brief 创建一个由GCMP SDK提供的缺省的GDC标准的实现。
        /// 
        /// return 返回由GCMP SDK提供的缺省的GDC标准的访问接口。
        static OwnerPtr<ISpecificStandardCodeSystem> CreateDefaultStandardCodeSystem();

        /// \brief 获取标准的名称。
        /// \param name 标准的名称。
        virtual bool GetStandardName(std::wstring& name) = 0;

        /// \brief 获取标准的版本号。
        /// \return 获取整型的标准版本号
        virtual int GetStandardVersion() const = 0;

        /// \brief 获取所有的标准编码数据
        /// \param allStandardCodeItems 获得的标准编码数据集合。
        /// \param version 标准数据的版本号。
        /// \return 成功则返回true，失败则返回false。
        virtual bool GetAllStandardCodeItems(std::unordered_map<std::wstring, OwnerPtr<IStandardCodeItem>>& allStandardCodeItems, int version) const =0;

        /// \brief 获取标准的版本号。
        /// \param version 标准的版本号。
        GCMP_OBSOLETE_API(2021/03/01, ISpecificStandardCodeSystem::GetStandardVersion() const) virtual bool GetStandardVersion(std::wstring& version) = 0;
    };
}
